/*******************************************************************************
 * The MIT License (MIT)
 * 
 * Copyright (c) 2017 Jean-David Gadina - www.xs-labs.com
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/

/*!
 * @header      GitHubUpdaterProgressWindowController.h
 * @copyright   (c) 2017, Jean-David Gadina - www.xs-labs.com
 */

#import <Cocoa/Cocoa.h>

NS_ASSUME_NONNULL_BEGIN

/*!
 * @class       GitHubProgressWindowController
 * @abstract    Window controller for the progress window.
 * @discussion  This window controller is used for all progress activity,
 *              checing for updates or installing an update.
 */
@interface GitHubProgressWindowController: NSWindowController

/*!
 * @property    title
 * @abstract    The progress title message.
 */
@property( atomic, readwrite, strong, nullable ) NSString * title;

/*!
 * @property    message
 * @abstract    The progress message.
 */
@property( atomic, readwrite, strong, nullable ) NSString * message;

/*!
 * @property    indeterminate
 * @abstract    Whether the progress is indeterminate.
 * @disucssion  This is used for the progress bar.
 */
@property( atomic, readwrite, assign ) BOOL indeterminate;

/*!
 * @property    progress
 * @abstract    The current progress.
 * @disucssion  This is used for the progress bar.
 */
@property( atomic, readwrite, assign ) double progress;

/*!
 * @property    progressMin
 * @abstract    The progress minimum value
 * @disucssion  This is used for the progress bar.
 */
@property( atomic, readwrite, assign ) double progressMin;

/*!
 * @property    progressMax
 * @abstract    The progress maximum value
 * @disucssion  This is used for the progress bar.
 */
@property( atomic, readwrite, assign ) double progressMax;

/*!
 * @property    cancel
 * @abstract    A block invoked when the user presses the cancel button.
 * @discussion  If nil, the cancel button will not be shown.
 */
@property( atomic, readwrite, strong, nullable ) void ( ^ cancel )( void );

@end

NS_ASSUME_NONNULL_END
